Sertifi API Web Service
Method/Services/CreatePayment
Description
Creates a payment item in a file.
Request (CreatePaymentSoapIn)

The request body is of type CreatePayment.

Request Body Parameters

NameDescriptionData Type
p_APICodeThe API code of the site.  This can be found through your Sertifi web interface under Administration -> Account Settings.xml:string
p_FileIDThe id of the relevant file.xml:string
amountThe amount for the payment (1 period/decimal point and no commas allowed.)xml:decimal
descriptionThe name of the payment that signers see.xml:string
recurrenceThe interval at which the payment gets charged.PaymentReccurence
datePaymentDueMust be in the format dd/MM/yyyy (Day/month/4-digit year)xml:string
operation

"Pay" (charge card automatically) or "Authorize" (charge card later)

PaymentOperationType
operation Element datePaymentDue Element recurrence Element description Element amount Element p_FileID Element p_APICode Element Sequence CreatePayment Element
Response (CreatePaymentSoapOut)

The response body is of type CreatePaymentResponse.

Response Body Parameters

NameDescriptionData Type
CreatePaymentResultpayment id or error message.xml:string
CreatePaymentResult Element Sequence CreatePaymentResponse Element
Remarks
Common error messages:
"ERROR: Invalid API Code"
"ERROR: Payments are not enabled for this account."
"ERROR: File could not be accessed"
"ERROR: Payments can no longer be added to this file."
"ERROR: Could not save payment"
"ERROR: datePaymentDue not in recognized date format yyyy/MM/dd"
"ERROR: Operation <operation> is not enabled or supported for payment gateway."
See Also
All Operations Resource GroupSertifi API Web Service

 

 


© Sertifi, Inc., 2016 All Rights Reserved.

Send comments on this topic.